Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs and test #171

Merged
merged 12 commits into from
Jan 5, 2023
Merged

Fix docs and test #171

merged 12 commits into from
Jan 5, 2023

Conversation

thomaspinder
Copy link
Collaborator

This PR fixes some bugs within the documentation. The bugs are all hangovers from the recent update to Jax v0.4.

The PR also includes a testing job to our CircleCI workflow to ensure that all notebooks compile before using them to build the documentation site.

Pull request type

Please check the type of change your PR introduces:

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation content changes
  • Other (please describe):

What is the current behavior?

The docs do not currently build. Worse still, we will not know this as they are not being tested.

Issue Number: #169 #170

@thomaspinder thomaspinder added the bug Something isn't working label Jan 4, 2023
@thomaspinder thomaspinder self-assigned this Jan 4, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 4, 2023

Codecov Report

Merging #171 (4cb147e) into master (696ed9d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #171   +/-   ##
=======================================
  Coverage   96.77%   96.77%           
=======================================
  Files          15       15           
  Lines        1425     1425           
=======================================
  Hits         1379     1379           
  Misses         46       46           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

examples/haiku.pct.py Outdated Show resolved Hide resolved
@thomaspinder
Copy link
Collaborator Author

@daniel-dodd I'm going to move the docs building back to a Github workflow for now.

Copy link
Member

@daniel-dodd daniel-dodd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super @thomaspinder, this looks good to me.

@daniel-dodd daniel-dodd merged commit c51bcca into master Jan 5, 2023
@thomaspinder thomaspinder deleted the test_docs branch April 7, 2023 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants